﻿#region MIT Licence
/*
 * Copyright (C) 2014 PdfCreative
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software 
 * and associated documentation files (the "Software"), to deal in the Software without restriction, 
 * including without limitation the rights to use, copy, modify, merge, publish, distribute, 
 * sublicense, and/or sell copies of the Software, and to permit persons to whom 
 * the Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included 
 * in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, 
 * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE 
 * AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, 
 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
#endregion

using System;
using System.Collections.Generic;
using System.IO;
using System.Text;

namespace PdfCreative.Pdf.Writer.Images
{
    /// <summary>
    /// The ImageInfo class is the abstract base class for all ImageInfo classes. It encapsulates the image information that is
    /// relevant to the Writer.
    /// </summary>
    public abstract class ImageInfo
    {
        // Public properties
        // =================
        #region Public properties
        /// <summary>
        /// Retrieves the colour space of the image.
        /// </summary>
        public virtual PdfColourSpace ColourSpace { get { return PdfColourSpace.DeviceRGB; } }

        /// <summary>
        /// Retrieves the width of the image.
        /// </summary>
        public abstract int Width { get; }

        /// <summary>
        /// Retrieves the height of the image.
        /// </summary>
        public abstract int Height { get; }
        #endregion



        // Public methods
        // ==============
        #region Public methods
        /// <summary>
        /// Parses the image data found in the specified file.
        /// </summary>
        /// <param name="filename">The file to read the image data from</param>
        /// <exception cref="ImageParseException">An error occurred while reading the image data</exception>
        public abstract void Parse(string filename);

        /// <summary>
        /// Parses the image data in the specified stream.
        /// </summary>
        /// <param name="stream">The stream to read the image data from</param>
        /// <exception cref="ImageParseException">An error occurred while reading the image data</exception>
        public abstract void Parse(Stream stream);
        #endregion

    } // ImageInfo class
}
